cs-portal-liferay-xapi
📘 Documentación de la API - cs-portal-liferay-xapi
Esta sección describe los atributos y uso del servicio cs-portal-liferay-xapi
.
💂️ Información Base
- Título de la API: cs-portal-liferay-xapi
- Versión: v1
- URL Base:
https://cs-portal-liferay-xapi-{env}-v1.us-e1.cloudhub.io/api/
Reemplaza {env}
con:
dev
(Desarrollo)qa
(Aseguramiento de Calidad)prod
(Producción)
🔑 Autenticación
Encabezados Requeridos
Encabezado | Tipo | Descripción |
---|---|---|
Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
client_id | String | Identificador único para clientes API |
invoker | String | Objeto JSON con información de contexto de solicitud |
- Authorization
- Longitud: 36 - 37 caracteres
- Ejemplo:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
- invoker
- Ejemplo:{"application": "Portal","addressIPUser": "192.168.80.13","loginUser": "Cristian1997","userName": "Cristian Cardona"}
📊 Parámetros Comunes
Parámetro | Tipo | Descripción | Requerido |
---|---|---|---|
client_id | String | Identificador de cliente API | ✅ |
Authorization | String | Token Bearer para autenticación | ✅ |
invoker | JSON | Metadatos de contexto de solicitud | ✅ |
🔐 Esquemas de Seguridad
Aplicación de ID de Cliente
Campo | Tipo | Requerido | Longitud | Regex |
---|---|---|---|---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
Campo | Tipo | Requerido | Longitud | Regex |
---|---|---|---|---|
Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
Código | Descripción | Solución Sugerida |
---|---|---|
400 | Solicitud Incorrecta | Verificar sintaxis y parámetros de la solicitud. |
401 | No Autorizado | Validar credenciales de autenticación. |
404 | No Encontrado | Confirmar la URL del endpoint. |
500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Agosto 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en julio 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services